-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: re-add zeebe-user-task
rule as a warning
#183
Conversation
I will have a look today. |
If the feature is going to be removed at some point of time, let's mark it as deprecated. This is what we do with secrets. We could also add the support removal version if possible, though for the specific feature from this PR it has been fluent, so I'd rather not recommend it here. Regarding recommendations in general, I don't even think there's space for such category in this repository. This would be an excellent case for a best-practices plugin (bpmnlint-plugin-camunda?). Note this project's mission:
I am collecting potential configurable rules in https://github.com/camunda/product-hub/issues/2013, so maybe there's something to contribute there for the user tasks too. |
index.js
Outdated
@@ -162,6 +163,7 @@ const rules = { | |||
'no-zeebe-properties': './rules/camunda-cloud/no-zeebe-properties', | |||
'no-zeebe-user-task': './rules/camunda-cloud/no-zeebe-user-task', | |||
'priority-definition': './rules/camunda-cloud/priority-definition', | |||
'recommend-zeebe-user-task': './rules/camunda-cloud/recommend-zeebe-user-task', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's rename this to something like no-job-worker-user-task
.
Code-wise, the contribution looks solid. So we only need to adjust the message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As in the comment above.
We already had a rule but removed it: #179 Feels like we're going in circles. ♻️ |
Sorry for confusion. Yes, we removed the rule because the job worker implementation is kept in the upcoming release. My suggestion is to notify deprecation, and we can bring the rule you linked back when/if the job worker is actually removed. |
Hmm the comment that I linked makes me doubt what message we want to send in compat. Let's pause and clarify further in the epic linked. |
We had some discussions with @barmac sync to try and settle on the specific language / error type involved. We decided, without alterations, to use the same exact message and error type for "no extension is deprecated" as "must have extension" case. We came to this decision because the pattern was already in use with another warning. What this basically amounts to is that we are re-adding the |
73d68ba
to
8048cdf
Compare
recommend-zeebe-user-task
rulezeebe-user-task
rule as a warning
8048cdf
to
ef4c964
Compare
Thanks! |
Related to camunda/camunda-modeler#4690
Added a new reporting category. Base message uses the terminology "is recommended to" as opposed to "must", since this is just the base message I think this is a good generic error here.